home *** CD-ROM | disk | FTP | other *** search
/ 17 Bit Software 6: Level 6 / 17 Bit - Level 6 (1998)(Epic Marketing)[!].iso / quartz / q1082.dms / q1082.adf / doc / xfig.man < prev   
Text File  |  1991-07-18  |  18KB  |  480 lines

  1.  
  2.  
  3.  
  4. XFIG(1)                  USER COMMANDS                    XFIG(1)
  5.  
  6.  
  7.  
  8. NAME
  9.      xfig - Facility for Interactive Generation of figures  under
  10.      X11
  11.  
  12. SYNOPSIS
  13.      xfig [ -ri[ght] ] [ -le[ft] ] [ -L[andscape] ] [ -P[ortrait]
  14.      ]  [ -w[idth] inches ] [ -h[eight] inches ] [ -no[track] ] [
  15.      -tr[ack] ] [ file ]
  16.  
  17. DESCRIPTION
  18.      Xfig is a menu-driven tool that allows the user to draw  and
  19.      manipulate  objects  interactively  in an X window.  It runs
  20.      under X version 11 release 2  and  requires  a  three-button
  21.      mouse.   File specifies the name of a file to be edited. The
  22.      description of objects in the file will be read at the start
  23.      of xfig.
  24.  
  25.      The output from xfig can be printed in several ways
  26.  
  27.      troff - f2p (xfig to pic(1) translator, also  known  by  its
  28.      previous name ftop(1L)) is used to translate xfig files into
  29.      pic(1) language.  The resulting file may then  be  processed
  30.      in the same maner as any other pic file.
  31.  
  32.      postscript - f2ps (xfig to postscript translator) is used to
  33.      produce a postscript file from an xfig file.  The postscript
  34.      file can be sent directly to a postscript printer.
  35.  
  36.      LaTeX - fig2latex (xfig  to  LaTeX  translator)  produces  a
  37.      LaTeX file from an xfig file.  This file contains LaTeX pic-
  38.      ture environment commands and can be  processed  along  with
  39.      other LaTeX commands.
  40.  
  41.      PiCTeX - fig2tex (xfig  to  PiCTeX  translator)  produces  a
  42.      PiCTeX  file  from  an xfig file.  This file contains macros
  43.      that can be used with the PiCTeX environment  under  TeX  or
  44.      LaTeX.
  45.  
  46. OPTIONS
  47.      -ri  Change the position of the panel window to the right of
  48.           the canvas window (default: left).
  49.  
  50.      -le  Change the position of the panel window to the left  of
  51.           the canvas window.
  52.  
  53.      -L   Make xfig come up in landscape mode (10" x 7.5").
  54.  
  55.      -P   Make xfig come up in portrait mode (7.5" x  10").  This
  56.           is the default.
  57.  
  58.      -w inches
  59.           Make xfig come up inches wide.
  60.  
  61.      -h inches
  62.           Make xfig come up inches high.
  63.  
  64.      -tr  Turn on cursor (mouse) tracking arrows.
  65.  
  66.      -no  Turn off cursor (mouse) tracking arrows.
  67.  
  68. GRAPHICAL OBJECTS
  69.      The objects in xfig are divided into primitive  objects  and
  70.      compound  object.  The  primitive  objects are: ARC, CIRCLE,
  71.      CLOSED SPLINE, ELLIPSE, POLYLINE, POLYGON, SPLINE, and TEXT.
  72.      A  primitive  can  be  moved,  rotated,  flipped,  copied or
  73.      erased.  A compound object is composed of primitive objects.
  74.      The  primitive objects that constitute a compound can not be
  75.      individually modified, but they can  be  manipulated  as  an
  76.      entity; a compound can be moved, rotated, flipped, copied or
  77.      erased.  An extra function that can be applied to a compound
  78.      object  is  scaling,  which  is  not available for primitive
  79.      objects.
  80.  
  81. DISPLAY WINDOWS
  82.      Five windows comprise the display  area  of  xfig:  the  top
  83.      ruler, the side ruler, the panel window, the message window,
  84.      and the canvas window. The  message  window  always  appears
  85.      below  the others; it is the area in which messages are sent
  86.      and received.  The panel window can be placed to the left or
  87.      right of the the canvas window (default: left).
  88.  
  89. POP-UP MENU
  90.      The pop-up menu appears  when  the  right  mouse  button  is
  91.      pressed with the cursor positioned within the canvas window.
  92.      Positioning the cursor  over  the  desired  menu  entry  and
  93.      releasing the button selects a menu entry.
  94.  
  95.      There are a number of file accessing functions in the pop-up
  96.      menu.   Most  of  the  time  when  one of these functions is
  97.      selected, the user will be asked for a file  name.   If  the
  98.      specified  file can be located and the access permission are
  99.      granted, xfig will carry out the function.  However in  case
  100.      things  go  wrong,  xfig will abort the function and printed
  101.      the causes on the message window.
  102.  
  103.      Undo Undo the last object creation or modification.
  104.  
  105.      Redisplay
  106.           Redraw the canvas.
  107.  
  108.      Remove all
  109.           Remove  all  objects  on  the  canvas  window  (can  be
  110.           undone).
  111.  
  112.      Edit file ...
  113.           The current contents of  the  canvas  are  cleared  and
  114.           objects  are  read  from  the specified file.  The user
  115.           will be asked for a file name.  This file  will  become
  116.           the current file.
  117.  
  118.      Save Save the current contents of the canvas in the  current
  119.           file.   If  no  file  is being edited, the user will be
  120.           asked for a file name as in the "Save in ..." function.
  121.  
  122.      Read file ...
  123.           Read objects from the specified  file  and  merge  them
  124.           with  objects  already  shown on the canvas.  (The user
  125.           will be asked for a file name.)
  126.  
  127.      Save as ...
  128.           Save objects on the screen into a file specified by the
  129.           user.  (The user will be asked for a file name.)
  130.  
  131.      Status
  132.           Show the name of the current file and directory.
  133.  
  134.      Change Directory
  135.           Change the working directory.  Any file name without  a
  136.           full  path  name will employ the current working direc-
  137.           tory.
  138.  
  139.      Save & Exit
  140.           Save the objects in the  current  file  and  exit  from
  141.           xfig.   If  there  is no current file, the user will be
  142.           asked for a file name.  No confirmation will be asked.
  143.  
  144.      Quit Exit from xfig, discarding all objects. The  user  will
  145.           be  asked  to  confirm the action, by clicking the left
  146.           button.
  147.  
  148.      Save as BITMAP ...
  149.           Create a bitmap picture of the drawings  for  use  with
  150.           other  tools  (for  example,  for use as an icon).  The
  151.           smallest rectangular area of  pixels  that  encompasses
  152.           the  figure is written to the named file (the user will
  153.           be asked for a file name) from top row  to  bottom  and
  154.           left  to  right  (in  Sun  raster  format).   Only TEXT
  155.           objects that are parts  of  compound  objects  will  be
  156.           treated  as parts of the picture; other texts are saved
  157.           as objects in xfig format following  the  bitmap  data.
  158.           The  coordinates  of  these text objects can be used to
  159.           identify locations on the bitmap.
  160.  
  161. PANEL WINDOW MANIPULATION FUNCTIONS
  162.      Icons in the  panel  window  represent  object  manipulation
  163.      functions,  modes  and  other  drawing or modification aids.
  164.      Manipulation  functions  are  selected  by  positioning  the
  165.      cursor  over  it  and  clicking  the left mouse button.  The
  166.      selected icon is highlighted, and a message  describing  its
  167.      function appears in the message window.
  168.  
  169.      The left and middle buttons are used  to  creat  and  modify
  170.      objects  in  the  canvas  window.   Most  actions start with
  171.      clicking of the left button and end  with  clicking  of  the
  172.      right  button.  There is no need to hold down a button while
  173.      positioning the cursor.
  174.  
  175. PANEL WINDOW COMMAND DESCRIPTIONS
  176.      Entries in the panel  window  can  be  classified  into  two
  177.      categories:  object  creation/modification/removal  commands
  178.      (only one of which may be active at any one time), and draw-
  179.      ing aids (which act as toggle switches).  There are two ways
  180.      for drawing circles, two for ellipses, two for  splines  and
  181.      two  for  closed splines.  There are two basic splines.  One
  182.      is the interpolated spline in which the spline pass thorough
  183.      the  entered points (knots).  The other is the normal spline
  184.      in which on control points are passed by the spline  (except
  185.      for the two end points in the open spline).
  186.  
  187. OBJECT CREATION/MODIFICATION/REMOVAL
  188.      Multiple commands are grouped thematically in the  following
  189.      descriptions (which is listed alphabetically).
  190.  
  191.      ADD/DELETE ARROWS
  192.           Add or delete arrow heads for POLYLINE, POLYGON, SPLINE
  193.           or  CLOSED  SPLINE  objects (points of a BOX can not be
  194.           added or deleted).
  195.  
  196.      ADD/DELETE POINTS
  197.           Add or delete points for POLYLINE, POLYGON,  SPLINE  or
  198.           CLOSED SPLINE objects (points of a BOX can not be added
  199.           or deleted).
  200.  
  201.      ARC  Create an arc.  Specify three  points  using  the  left
  202.           button.
  203.  
  204.      BOX  Create rectangular boxes.  Start with the  left  button
  205.           and terminate with the right button.
  206.  
  207.      BREAK COMPOUND
  208.           Break  a compound object to allow manipulation  of  its
  209.           component parts.  Click the left button on the bounding
  210.           box of the compound object.
  211.  
  212.      CIRCLE
  213.           Create circles by specifying their radii or  diameters.
  214.           Click  the  left  button on the canvas window, move the
  215.           cursor until the desired radius or diameter is reached,
  216.           then  click  the middle button to terminate. The circle
  217.           will be drawn after the pressing of the middle button.
  218.  
  219.      CLOSED INTERPOLATED SPLINE
  220.           Create closed or periodic  splines.   The  function  is
  221.           similar  to  POLYGON  except that a closed interpolated
  222.           spline is drawn.  The  spline  will  pass  through  the
  223.           points (knots).
  224.  
  225.      CLOSED SPLINE
  226.           Create closed or periodic spline objects.  The function
  227.           is  similar to POLYGON except that a closed spline will
  228.           be drawn instead of polygon.  The  entered  points  are
  229.           just control points; i.e., the spline will not pass any
  230.           of these points.
  231.  
  232.      COPY Copy object.  Click the left button over  part  of  the
  233.           object  to  be  copied (for CIRCLE and ELLIPSE objects,
  234.           position on their circumferences).  Drag the object  to
  235.           the desired position and click the middle button.  This
  236.           function as  well  as  the  following  three  functions
  237.           (MOVE,  MOVE  POINT,  REMOVE)  will cause point markers
  238.           (manipulation aids) to be shown on the  canvas  window.
  239.           There are no markers for CIRCLE or ELLIPSE objects.
  240.  
  241.      ELLIPSE
  242.           Create ellipses using the same  procedure  as  for  the
  243.           drawing of circles.
  244.  
  245.      GLUE Glue the objects within a bounding box into a  compound
  246.           object (the bounding box itself is not part of the fig-
  247.           ure; it is a visual aid for manipulating the compound).
  248.  
  249.      INTERPOLATED SPLINE
  250.           Create (cubic spline) spline  objects.   Enter  control
  251.           vectors  in  the same way as for creation of a POLYLINE
  252.           object.  At least three points  (two  control  vectors)
  253.           must  be  entered.   The  spline  will pass through the
  254.           entered points.
  255.  
  256.      MOVE Move objects in the same way as in COPY.
  257.  
  258.      MOVE POINT
  259.           Modify  the  position  of  points  of  POLYLINE,   BOX,
  260.           POLYGON,  ELLIPSE,  ARC  and SPLINE objects.  Click the
  261.           left button over  the  desired  point,  reposition  the
  262.           point,  and click the middle button.  Note that BOX and
  263.           POLYGON  objects  are  internally  stored  as  POLYLINE
  264.           objects,  and  therefore moving certain points may open
  265.           these objects.
  266.  
  267.      POLYGON
  268.           Same as POLYLINE except that a line  segment  is  drawn
  269.           connecting the first and last points entered.
  270.  
  271.      POLYLINE
  272.           Create polylines (line segments connecting  a  sequence
  273.           of  points).   Enter points by clicking the left button
  274.           at the desired positions on the canvas  window.   Click
  275.           the middle button to terminate.
  276.  
  277.      REMOVE
  278.           Remove (or delete) objects.
  279.  
  280.      SCALE COMPOUND
  281.           Only compound objects can be scaled.   Click  the  left
  282.           button  on  a  corner  of the bounding box, stretch the
  283.           bounding box to the desired size, and click the  middle
  284.           button.   Or  click  the  left  button on a side of the
  285.           bounding box, stretch that side to  the  desired  size,
  286.           and click the middle button.
  287.  
  288.      SPLINE
  289.           Create (quadratic spline) spline objects.   Enter  con-
  290.           trol vectors in the same way as for creation of a POLY-
  291.           LINE object.  At least three points (two  control  vec-
  292.           tors)  must  be entered.  The spline will pass only the
  293.           two end points.
  294.  
  295.      TEXT Create text strings.  Click  the  left  button  at  the
  296.           desired  position on the canvas window, then enter text
  297.           from the keyboard.  A DEL or ^H (backspace) will delete
  298.           a  character,  while  a  ^U  will kill the entire line.
  299.           Terminate by clicking the middle button or  typing  the
  300.           return  key.   To  edit text, click on an existing text
  301.           string with the left button.  Insertion  of  characters
  302.           will take place at that point.
  303.  
  304.      TURN Turn POLYGON into a CLOSED INTERPOLATED SPLINE  object,
  305.           or turn POLYLINE into a INTERPOLATED SPLINE object.
  306.  
  307. DRAWING AIDS
  308.      Drawing aids act as toggle switches. More than  one  can  be
  309.      selected  at  a  time  (except for GRID and the line drawing
  310.      modes).
  311.  
  312.      AUTO FORWARD/BACKWARD ARROW
  313.           Automatically add forward/backward arrow heads to POLY-
  314.           LINE, SPLINE or ARC objects.
  315.  
  316.      FLIP Invert the object (middle button) or produce a  mirror-
  317.           image copy of an object (left button). Point to part of
  318.           the object ("the handle"), click the  appropriate  but-
  319.           ton.
  320.  
  321.      GRID Display either the quarter- or  half-inch  grids  (left
  322.           button).
  323.  
  324.      MAGNET
  325.           Round points to the nearest  1/16  of  an  inch.   This
  326.           affects every function, and is provided as an alignment
  327.           aid.
  328.  
  329.      UNRESTRICTED
  330.           Allow lines to be drawn with any slope.
  331.  
  332.      MANHATTAN
  333.           Enforce drawing of lines in the horizontal and vertical
  334.           direction  only.   Both  MANHATTAN  and MOUNTAIN can be
  335.           turned on simultaneously.  The  creations  of  POLYGON,
  336.           POLYLINE  and  SPLINE objects are affected by these two
  337.           modes.
  338.  
  339.      MOUNTAIN
  340.           Enforce drawing of only diagonal lines.  Both MANHATTAN
  341.           and MOUNTAIN can be turned on simultaneously. The crea-
  342.           tions of  POLYGON,  POLYLINE  and  SPLINE  objects  are
  343.           affected by these two modes.
  344.  
  345.      MANHATTAN MOUNTAIN
  346.           Allow lines to be drawn at any slope  allowed  when  in
  347.           MOUNTIAIN or MANHATTAN modes.
  348.  
  349.      LATEX LINE
  350.           Allow lines to be drawn only at  slopes  which  can  be
  351.           handled  by  LaTeX  picture  environment lines: slope =
  352.           x/y, where x,y are integers in the range [-6,6].
  353.  
  354.      LATEX VECTOR
  355.           Allow lines to be drawn only at  slopes  which  can  be
  356.           handled  by  LaTeX picture environment vectors: slope =
  357.           x/y, where x,y are integers in the range [-4,4].
  358.  
  359.      ROTATE
  360.           Rotate the object (middle button) or copy (left button)
  361.           +90 degrees.
  362.  
  363.      SOLID/DASHED LINE STYLE
  364.           Toggle between solid and dashed line styles.  The  dash
  365.           length is fixed at 0.05 inch.
  366.  
  367. X DEFAULTS
  368.      The       overall        widget        name(Class)        is
  369.      xfig.fig(Fig.TopLevelShell).     This   set   of   resources
  370.      correspond to the command line arguments:
  371.  
  372.      trackCursor (boolean:on) -track and -notrack arguments
  373.  
  374.      justify     (boolean:false) -right and -left arguments
  375.  
  376.      landscape   (boolean:false) -Landscape and  -Portrait  argu-
  377.                  ments
  378.  
  379.      debug       (boolean:off) -debug arguments
  380.  
  381.      width       (integer:7.5 or 10 inches) -width argument
  382.  
  383.      height      (integer:10 or 7.5 inches) -height argument
  384.  
  385.      reverseVideo(boolean:off) -inverse argument
  386.  
  387.      These arguments correspond to  the  widgets  which  make  up
  388.      xfig.
  389.  
  390.      overall window form(Form)
  391.  
  392.      side panel     form.panel(Form.Box)
  393.  
  394.      icons          form.panel.button(Form.Box.Command)
  395.  
  396.      top ruler      form.truler(Form.Label)
  397.  
  398.      side ruler     form.sruler(Form.Label)
  399.  
  400.      canvas         form.canvas(Form.Label)
  401.  
  402.      message window form.message(Form.Command)
  403.  
  404.      menu           form.popup_menu.menu(Form.OverrideShell.Box)
  405.  
  406.      menu title     form.popup_menu.menu.title(Form.OverrideShell.Box.Label)
  407.  
  408.      menu items     form.popup_menu.menu.pane(Form.OverrideShell.Box.Command)
  409.  
  410.      For  example, to set the background of the panel to blue the
  411.      resource would be:
  412.      xfig*form.panel.background: blue
  413.  
  414.      NOTE: The font used in the canvas cannot be changed at  this
  415.      time.
  416.  
  417. BUGS
  418.      Text strings will appear differently on hard  copy,  because
  419.      the display fonts are fixed-width fonts while the fonts used
  420.      by the typesetter systems are variable-width fonts.
  421.  
  422.      A double quote in a text string should be preceded by a back
  423.      slash if the it is to be printed through pic(1).
  424.  
  425.      Objects that extend beyond the canvas window may cause image
  426.      shrinkage  in hard copy printed by pic(1), since it will try
  427.      to fit every object onto a single 8.5" x 11" page.
  428.  
  429.      Ellipses which are too narrow may cause xfig  to  loop  for-
  430.      ever.
  431.  
  432.      Objects which are created while one of the grids is  on  may
  433.      appear  ragged. This can be corrected by selecting Redisplay
  434.      from the pop-up menu.
  435.  
  436.      The X11 cursors are not the original ones  but  chosen  from
  437.      X11's cursor font.
  438.  
  439. SEE ALSO
  440.      Brian W. Kernighan PIC - A Graphics Language for Typesetting
  441.      User Manual
  442.      ditroff(1),  f2p(1),  f2ps(1),   fig2latex(1),   fig2tex(1),
  443.      pic(1), troff(1), tex(1), latex(1)
  444.  
  445. ACKNOWLEDGEMENT
  446.      Many thanks goes to Professor Donald E. Fussell who inspired
  447.      the creation of this tool.
  448.  
  449. AUTHORS
  450.      Original author:
  451.      Supoj Sutanthavibul
  452.      University of Texas at Austin
  453.      (supoj@sally.utexas.edu)
  454.  
  455.      Manual page modified by:
  456.      R. P. C. Rodgers
  457.      UCSF School of Pharmacy
  458.      San Francisco, CA 94118
  459.  
  460.      The LaTeX line drawing modes were contributed by:
  461.      Frank Schmuck
  462.      Cornell University
  463.  
  464.      X11 port by:
  465.      Ken Yap
  466.      Rochester
  467.      (ken@cs.rochester.edu)
  468.  
  469.      Variable window sizes, cleanup of X11 port, right hand  side
  470.      panel under X11, X11 manual page provided by:
  471.      Dana Chee
  472.      Bellcore
  473.      (dana@bellcore.com)
  474.  
  475.      Cleanup of color port to X11 by:
  476.      John T. Kohl
  477.  
  478.      MIT
  479.      (jtkohl@athena.mit.edu)
  480.